Skip to content

docs: Update conventions after snake_case migration.#141

Merged
nedseb merged 1 commit intomainfrom
docs/update-readme-after-snake-case
Mar 15, 2026
Merged

docs: Update conventions after snake_case migration.#141
nedseb merged 1 commit intomainfrom
docs/update-readme-after-snake-case

Conversation

@nedseb
Copy link
Copy Markdown
Contributor

@nedseb nedseb commented Mar 15, 2026

Part of #82

Summary

Update README.md to reflect the completed snake_case migration:

  • APDS9960 example: enableLightSensor()enable_light_sensor(), readAmbientLight()read_ambient_light()
  • Coding conventions: remove "Legacy camelCase is acceptable" — now enforced by ruff
  • I2C helpers: remove mention of legacy names as acceptable

Test plan

  • ruff check . passes
  • 99 mock tests pass

@nedseb nedseb force-pushed the docs/update-readme-after-snake-case branch from 9a4854d to 6dba6a4 Compare March 15, 2026 07:43
@nedseb nedseb requested a review from Copilot March 15, 2026 07:44
@nedseb nedseb self-assigned this Mar 15, 2026
@nedseb nedseb added the enhancement New feature or request label Mar 15, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-only update to README.md reflecting the completed snake_case migration across all drivers.

Changes:

  • Updated APDS9960 usage example to use snake_case method names
  • Removed "legacy camelCase is acceptable" language from coding conventions
  • Simplified I2C helpers convention to require snake_case only

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@nedseb nedseb merged commit dd5e082 into main Mar 15, 2026
8 checks passed
@nedseb nedseb deleted the docs/update-readme-after-snake-case branch March 15, 2026 07:45
@semantic-release-updater
Copy link
Copy Markdown

🎉 This PR is included in version 0.0.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants